home *** CD-ROM | disk | FTP | other *** search
/ Apple WWDC 1996 / WWDC96_1996 (CD).toast / Technology Materials / MacOS 8 Resources / Developer Tools / Mac OS 8 Interfaces & Libraries / Interfaces / CIncludes / DigitalSignature.h < prev    next >
C/C++ Source or Header  |  1996-05-01  |  17KB  |  386 lines
  1. /*
  2.      File:        DigitalSignature.h
  3.  
  4.      Contains:    Digital Signature Interfaces.
  5.  
  6.      Version:    Technology:    AOCE toolbox 1.02
  7.                  Release:    Universal Interfaces 3.0d3 on Copland DR1
  8.  
  9.      Copyright:    © 1984-1996 by Apple Computer, Inc.  All rights reserved.
  10.  
  11.      Bugs?:        If you find a problem with this file, send the file and version
  12.                  information (from above) and the problem description to:
  13.  
  14.                      Internet:    apple.bugs@applelink.apple.com
  15.                      AppleLink:    APPLE.BUGS
  16.  
  17. */
  18. #ifndef __DIGITALSIGNATURE__
  19. #define __DIGITALSIGNATURE__
  20.  
  21. #ifndef __TYPES__
  22. #include <Types.h>
  23. #endif
  24. #ifndef __MEMORY__
  25. #include <Memory.h>
  26. #endif
  27. #ifndef __FILES__
  28. #include <Files.h>
  29. #endif
  30.  
  31. #ifdef __cplusplus
  32. extern "C" {
  33. #endif
  34.  
  35. #if PRAGMA_IMPORT_SUPPORTED
  36. #pragma import on
  37. #endif
  38.  
  39. #if PRAGMA_ALIGN_SUPPORTED
  40. #pragma options align=mac68k
  41. #endif
  42.  
  43. #if FOR_SYSTEM7_ONLY
  44. /* values of SIGNameAttributeType */
  45.  
  46. enum {
  47.     kSIGCountryCode                = 0,
  48.     kSIGOrganization            = 1,
  49.     kSIGStreetAddress            = 2,
  50.     kSIGState                    = 3,
  51.     kSIGLocality                = 4,
  52.     kSIGCommonName                = 5,
  53.     kSIGTitle                    = 6,
  54.     kSIGOrganizationUnit        = 7,
  55.     kSIGPostalCode                = 8
  56. };
  57.  
  58. typedef unsigned short SIGNameAttributeType;
  59. /*
  60. Certificate status codes returned in SIGCertInfo or SIGSignerInfo from
  61. either SIGGetCertInfo or SIGGetSignerInfo respectively. kSIGValid means that
  62. the certificate is currently valid. kSIGPending means the certificate is
  63. currently not valid - but will be.  kSIGExpired means the certificate has
  64. expired. A time is always associated with a SIGCertStatus.  In each case the
  65. time has a specific interpretation.  When the status is kSIGValid the time is
  66. when the certificate will expire. When the status is kSIGPending the time is
  67. when the certificate will become valid. When the status is kSIGExpired the time
  68. is when the certificate expired. In the SIGCertInfo structure, the startDate
  69. and endDate fields hold the appropriate date information.  In the SIGSignerInfo
  70. structure, this information is provided in the certSetStatusTime field. In the
  71. SIGSignerInfo struct, the status time is actually represented by the SIGSignatureStatus
  72. field which can contain any of the types below. NOTE: The only time you will get 
  73. a kSIGInvalid status is when it pertains to a SIGSignatureStatus field and only when
  74. you get a signature that was created after the certificates expiration date, something
  75. we are not allowing on the Mac but that may not be restricted on other platforms. Also, 
  76. it will not be possible to get a kSIGPending value for SIGSignatureStatus on the Mac but
  77. possibly allowed by other platforms.
  78. */
  79. /* Values for SIGCertStatus or SIGSignatureStatus */
  80.  
  81. enum {
  82.     kSIGValid                    = 0,                            /* possible for either a SIGCertStatus or SIGSignatureStatus */
  83.     kSIGPending                    = 1,                            /* possible for either a SIGCertStatus or SIGSignatureStatus */
  84.     kSIGExpired                    = 2,                            /* possible for either a SIGCertStatus or SIGSignatureStatus * possible only for a SIGSignatureStatus */
  85.     kSIGInvalid                    = 3
  86. };
  87.  
  88. typedef unsigned short SIGCertStatus;
  89. typedef unsigned short SIGSignatureStatus;
  90. /* Gestalt selector code - returns toolbox version in low-order word */
  91.  
  92. enum {
  93.     gestaltDigitalSignatureVersion = 'dsig'
  94. };
  95.  
  96. /* Number of bytes needed for a digest record when using SIGDigest */
  97.  
  98. enum {
  99.     kSIGDigestSize                = 16
  100. };
  101.  
  102. typedef Byte SIGDigestData[16];
  103. typedef Byte *SIGDigestDataPtr;
  104. struct SIGCertInfo {
  105.     unsigned long                     startDate;                    /* cert start validity date */
  106.     unsigned long                     endDate;                    /* cert end validity date */
  107.     SIGCertStatus                     certStatus;                    /* see comment on SIGCertStatus for definition */
  108.     unsigned long                     certAttributeCount;            /* number of name attributes in this cert */
  109.     unsigned long                     issuerAttributeCount;        /* number of name attributes in this certs issuer */
  110.     Str255                             serialNumber;                /* cert serial number */
  111. };
  112. typedef struct SIGCertInfo SIGCertInfo;
  113.  
  114. typedef SIGCertInfo *SIGCertInfoPtr;
  115. struct SIGSignerInfo {
  116.     unsigned long                     signingTime;                /* time of signing */
  117.     unsigned long                     certCount;                    /* number of certificates in the cert set */
  118.     unsigned long                     certSetStatusTime;            /* Worst cert status time. See comment on SIGCertStatus for definition */
  119.     SIGSignatureStatus                 signatureStatus;            /* The status of the signature. See comment on SIGCertStatus for definition*/
  120. };
  121. typedef struct SIGSignerInfo SIGSignerInfo;
  122.  
  123. typedef SIGSignerInfo *SIGSignerInfoPtr;
  124. struct SIGNameAttributesInfo {
  125.     Boolean                         onNewLevel;
  126.     Boolean                         filler1;
  127.     SIGNameAttributeType             attributeType;
  128.     ScriptCode                         attributeScript;
  129.     Str255                             attribute;
  130. };
  131. typedef struct SIGNameAttributesInfo SIGNameAttributesInfo;
  132.  
  133. typedef SIGNameAttributesInfo *SIGNameAttributesInfoPtr;
  134. typedef Ptr SIGContextPtr;
  135. typedef Ptr SIGSignaturePtr;
  136. /*
  137. Certificates are always in order. That is, the signers cert is always 0, the
  138. issuer of the signers cert is always 1 etc... to the number of certificates-1.
  139. You can use this constant for readability in your code.
  140. */
  141.  
  142. enum {
  143.     kSIGSignerCertIndex            = 0
  144. };
  145.  
  146. /*
  147. Call back procedure supplied by developer, return false to cancel the current
  148. process.
  149. */
  150. typedef pascal Boolean (*SIGStatusProcPtr)(void );
  151.  
  152. #if GENERATINGCFM
  153. typedef UniversalProcPtr SIGStatusUPP;
  154. #else
  155. typedef SIGStatusProcPtr SIGStatusUPP;
  156. #endif
  157.  
  158. enum {
  159.     uppSIGStatusProcInfo = kPascalStackBased
  160.          | RESULT_SIZE(SIZE_CODE(sizeof(Boolean)))
  161. };
  162.  
  163. #if GENERATINGCFM
  164. #define NewSIGStatusProc(userRoutine)        \
  165.         (SIGStatusUPP) NewRoutineDescriptor((ProcPtr)(userRoutine), uppSIGStatusProcInfo, GetCurrentArchitecture())
  166. #else
  167. #define NewSIGStatusProc(userRoutine)        \
  168.         ((SIGStatusUPP) (userRoutine))
  169. #endif
  170.  
  171. #if GENERATINGCFM
  172. #define CallSIGStatusProc(userRoutine)        \
  173.         CallUniversalProc((UniversalProcPtr)(userRoutine), uppSIGStatusProcInfo)
  174. #else
  175. #define CallSIGStatusProc(userRoutine)        \
  176.         (*(userRoutine))()
  177. #endif
  178. /*
  179. Resource id's of standard signature icon suite, all sizes and colors are available.
  180. */
  181.  
  182. enum {
  183.     kSIGSignatureIconResID        = -16797,
  184.     kSIGValidSignatureIconResID    = -16799,
  185.     kSIGInvalidSignatureIconResID = -16798
  186. };
  187.  
  188. /*
  189.  -------------------------------------------------------------- CONTEXT CALLS -------------------------------------------------------------- 
  190. To use the Digital Signature toolbox you will need a SIGContextPtr.  To create
  191. a SIGContextPtr you simply call SIGNewContext and it will create and initialize
  192. a context for you.  To free the memory occupied by the context and invalidate
  193. its internal data, call SIGDisposeContext. An initialized context has no notion
  194. of the type of operation it will be performing however, once you call
  195. SIGSignPrepare SIGVerifyPrepare, or SIGDigestPrepare, the contexts operation
  196. type is set and to switch  to another type of operation will require creating a
  197. new context. Be sure to pass the same context to corresponding toolbox calls
  198. (ie SIGSignPrepare, SIGProcessData, SIGSign)  in other words mixing lets say
  199. signing and verify calls with the same context is not allowed.
  200. */
  201. extern pascal OSErr SIGNewContext(SIGContextPtr *context)
  202.  FOURWORDINLINE(0x203C, 0x0002, 0x076C, 0xAA5D);
  203.  
  204. extern pascal OSErr SIGDisposeContext(SIGContextPtr context)
  205.  FOURWORDINLINE(0x203C, 0x0002, 0x076D, 0xAA5D);
  206.  
  207. /*
  208.  -------------------------------------------------------------- SIGNING CALLS -------------------------------------------------------------- 
  209. Once you have created a SIGContextPtr, you create a signature by calling
  210. SIGSignPrepare once, followed by n calls to SIGProcessData, followed by one call
  211. toRcpt SIGSign. To create another signature on different data but for the same
  212. signer, don't dispose of the context and call SIGProcessData for the new data
  213. followed by a call SIGSign again. In this case the signer will not be prompted
  214. for their signer and password again as it was already provided.  Once you call
  215. SIGDisposeContext, all signer information will be cleared out of the context and
  216. the signer will be re-prompted.  The signer file FSSpecPtr should be set to nil
  217. if you want the toolbox to use the last signer by default or prompt for a signer
  218. if none exists.  The prompt parameter can be used to pass a string to be displayed
  219. in the dialog that prompts the user for their password.  If the substring "^1"
  220. (without the quotes) is in the prompt string, then the toolbox will replace it
  221. with the name of the signer from the signer selected by the user.  If an empty
  222. string is passed, the following default string will be sent to the toolbox
  223. "\pSigning as ^1.".  You can call any of the utility routines after SIGSignPrepare
  224. or SIGSign to get information about the signer or certs.
  225. */
  226. extern pascal OSErr SIGSignPrepare(SIGContextPtr context, const FSSpec *signerFile, ConstStr255Param prompt, Size *signatureSize)
  227.  FOURWORDINLINE(0x203C, 0x0008, 0x076E, 0xAA5D);
  228.  
  229. extern pascal OSErr SIGSign(SIGContextPtr context, SIGSignaturePtr signature, SIGStatusProcPtr statusProc)
  230.  FOURWORDINLINE(0x203C, 0x0006, 0x076F, 0xAA5D);
  231.  
  232. /*
  233.  -------------------------------------------------------------- VERIFYING CALLS -------------------------------------------------------------- 
  234. Once you have created a SIGContextPtr, you verify a signature by calling
  235. SIGVerifyPrepare  once, followed by n calls to SIGProcessData, followed by one
  236. call to SIGVerify. Check the return code from SIGVerify to see if the signature
  237. verified or not (noErr is returned on  success otherwise the appropriate error
  238. code).  Upon successfull verification, you can call any of the utility routines
  239. toRcpt find out who signed the data.
  240. */
  241. extern pascal OSErr SIGVerifyPrepare(SIGContextPtr context, SIGSignaturePtr signature, Size signatureSize, SIGStatusProcPtr statusProc)
  242.  FOURWORDINLINE(0x203C, 0x0008, 0x0770, 0xAA5D);
  243.  
  244. extern pascal OSErr SIGVerify(SIGContextPtr context)
  245.  FOURWORDINLINE(0x203C, 0x0002, 0x0771, 0xAA5D);
  246.  
  247. /*
  248.  ------------------------------------------------------------ DIGESTING CALLS ------------------------------------------------------------ 
  249. Once you have created a SIGContextPtr, you create a digest by calling
  250. SIGDigestPrepare once, followed by n calls to SIGProcessData, followed by one
  251. call to SIGDigest.  You can dispose of the context after SIGDigest as the
  252. SIGDigestData does not reference back into it.  SIGDigest returns the digest in
  253. digest.
  254. */
  255. extern pascal OSErr SIGDigestPrepare(SIGContextPtr context)
  256.  FOURWORDINLINE(0x203C, 0x0002, 0x0772, 0xAA5D);
  257.  
  258. extern pascal OSErr SIGDigest(SIGContextPtr context, SIGDigestData digest)
  259.  FOURWORDINLINE(0x203C, 0x0004, 0x0773, 0xAA5D);
  260.  
  261. /*
  262.  ------------------------------------------------------------ PROCESSING DATA ------------------------------------------------------------ 
  263. To process data during a digest, sign, or verify operation call SIGProcessData
  264. as many times as necessary and with any sized blocks of data.  The data needs to
  265. be processed in the same order during corresponding sign and verify operations
  266. but does not need to be processed in the same sized chunks (i.e., the toolbox
  267. just sees it as a continuous bit stream).
  268. */
  269. extern pascal OSErr SIGProcessData(SIGContextPtr context, const void *data, Size dataSize)
  270.  FOURWORDINLINE(0x203C, 0x0006, 0x0774, 0xAA5D);
  271.  
  272. /*
  273.  -------------------------------------------------------------- UTILITY CALLS -------------------------------------------------------------- 
  274. Given a context that has successfully performed a verification SIGShowSigner
  275. will  display a modal dialog with the entire distinguished name of the person
  276. who signed the data. the prompt (if supplied) will appear at the top of the
  277. dialog.  If no prompt is specified, the default prompt "\pVerification
  278. Successfull." will appear.
  279.  
  280. Given a context that has been populated by calling SIGSignPrepare, SIGSign or a
  281. successful SIGVerify, you can make the remaining utility calls:
  282.  
  283. SIGGetSignerInfo will return the SignerInfo record.  The certCount can be used
  284. toRcpt index into the certificate set when calling SIGGetCertInfo,
  285. SIGGetCertNameAttributes or SIGGetCertIssuerNameAttributes. The signingTime is
  286. only defined if the call is made after SIGSign  or SIGVerify. The certSetStatus
  287. will tell you the best status of the entire certificate set while
  288. certSetStatusTime will correspond to the time associated with that status (see
  289. definitions above).
  290.  
  291. SIGGetCertInfo will return the SIGCertInfo record when given a valid index into
  292. the cert set in  certIndex.  Note: The cert at index kSIGSignerCertIndex is
  293. always the signers certificate.  The  serial number, start date and end date
  294. are there should you wish to display that info.  The  certAttributeCount and
  295. issuerAttributeCount provide the number of parts in the name of that certificate
  296. or that certificates issuer respectively.  You use these numbers to index into
  297. either SIGGetCertNameAttributes or SIGGetCertIssuerNameAttributes to retrieve
  298. the name. The certStatus will tell you the status of the certificate while
  299. certStatusTime will correspond to the time associated with that status (see
  300. definitions above).
  301.  
  302. SIGGetCertNameAttributes and SIGGetCertIssuerNameAttributes return name parts
  303. of the certificate at  certIndex and attributeIndex.  The newLevel return value
  304. tells you wether the name attribute returned is at the same level in the name
  305. hierarchy as the previous attribute.  The type return value tells you  the type
  306. of attribute returned. nameAttribute is the actual string containing the name
  307. attribute.   So, if you wanted to display the entire distinguished name of the
  308. person who's signature was just validated you could do something like this;
  309.  
  310.     (...... variable declarations and verification code would preceed this sample ......)
  311.  
  312.     error = SIGGetCertInfo(verifyContext, kSIGSignerCertIndex, &certInfo);
  313.     HandleErr(error);
  314.  
  315.     for (i = 0; i <= certInfo.certAttributeCount-1; i++)
  316.         {
  317.         error = SIGGetCertNameAttributes(
  318.             verifyContext, kSIGSignerCertIndex, i, &newLevel, &type, theAttribute);
  319.         HandleErr(error);
  320.         DisplayNamePart(theAttribute, type, newLevel);
  321.         }
  322. */
  323. extern pascal OSErr SIGShowSigner(SIGContextPtr context, ConstStr255Param prompt)
  324.  FOURWORDINLINE(0x203C, 0x0004, 0x0775, 0xAA5D);
  325.  
  326. extern pascal OSErr SIGGetSignerInfo(SIGContextPtr context, SIGSignerInfo *signerInfo)
  327.  FOURWORDINLINE(0x203C, 0x0004, 0x0776, 0xAA5D);
  328.  
  329. extern pascal OSErr SIGGetCertInfo(SIGContextPtr context, unsigned long certIndex, SIGCertInfo *certInfo)
  330.  FOURWORDINLINE(0x203C, 0x0006, 0x0777, 0xAA5D);
  331.  
  332. extern pascal OSErr SIGGetCertNameAttributes(SIGContextPtr context, unsigned long certIndex, unsigned long attributeIndex, SIGNameAttributesInfo *attributeInfo)
  333.  FOURWORDINLINE(0x203C, 0x0008, 0x0778, 0xAA5D);
  334.  
  335. extern pascal OSErr SIGGetCertIssuerNameAttributes(SIGContextPtr context, unsigned long certIndex, unsigned long attributeIndex, SIGNameAttributesInfo *attributeInfo)
  336.  FOURWORDINLINE(0x203C, 0x0008, 0x0779, 0xAA5D);
  337.  
  338. /*
  339.  ------------------------------------------------------ FILE SIGN & VERIFY CALLS ---------------------------------------------------- 
  340. These calls allow you to detect the presence of a standard signtaure in a file as 
  341. well as sign and verify files in a standard way.  An example of this is the Finder, 
  342. which uses these calls to allow the user to "drop sign" a file.
  343.  
  344. To detect if a file is signed in the standard way, pass the FSSpec of the file to SIGFileIsSigned.
  345. A result of noErr means the file is in fact signed, otherwise, a kSIGNoSignature error will
  346. be returned.
  347.  
  348. Once you have created a SIGContextPtr, you can make calls to either sign or verify a file in
  349. a standard way: 
  350.  
  351. To sign a file, call SIGSignPrepare followed by 'n' number of calls to SIGSignFile,
  352. passing it the file spec for each file you wish to sign in turn.  You supply the context, the signature 
  353. size that was returned from SIGSignPrepare and an optional call back proc.  The call will take care of all
  354. the processing of data and affixing the signature to the file. If a signature already exists in the file, 
  355. it is replaced with the newly created signature.
  356.  
  357. To verify a file that was signed using SIGSignFile, call SIGVerifyFile passing it a new context and 
  358. the file spec.  Once this call has completed, if the verification is successfull, you can pass the context 
  359. to SIGShowSigner to display the name of the person who signed the file.
  360. */
  361. extern pascal OSErr SIGFileIsSigned(const FSSpec *fileSpec)
  362.  FOURWORDINLINE(0x203C, 0x0002, 0x09C4, 0xAA5D);
  363.  
  364. extern pascal OSErr SIGSignFile(SIGContextPtr context, Size signatureSize, const FSSpec *fileSpec, SIGStatusProcPtr statusProc)
  365.  FOURWORDINLINE(0x203C, 0x0008, 0x09C5, 0xAA5D);
  366.  
  367. extern pascal OSErr SIGVerifyFile(SIGContextPtr context, const FSSpec *fileSpec, SIGStatusProcPtr statusProc)
  368.  FOURWORDINLINE(0x203C, 0x0006, 0x09C6, 0xAA5D);
  369.  
  370. #endif
  371.  
  372. #if PRAGMA_ALIGN_SUPPORTED
  373. #pragma options align=reset
  374. #endif
  375.  
  376. #if PRAGMA_IMPORT_SUPPORTED
  377. #pragma import off
  378. #endif
  379.  
  380. #ifdef __cplusplus
  381. }
  382. #endif
  383.  
  384. #endif /* __DIGITALSIGNATURE__ */
  385.  
  386.